WSN Links
Version 3.15
------------------------------------------------------------------------

MANUAL

See the WSN Links online manual at
http://scripts.webmastersite.net/wsnlinks/wsnmanual/ for extensive
details on usage of WSN Links. This readme file only contains the most
basic introductory material which you'll need to get started.


RELEASE NOTES

Want to know what's changed since a previous version you used? See
releasenotes.txt in this directory for a full list of changes for each
version since 1.00.


NEW INSTALL (not uprade)

To install WSN Links:

   1. Extract files from the ZIP.
   2. Upload all the extracted files to your hosting space. Note that if
      your only language is English you don't need to upload
      templates/multilingual, and if you will be using a language other
      than English you don't need to upload templates/default.
   3. If you don't already have a database created, create one using
      your host's provided tools. (You may use an existing database if
      you like, if you have one.) Also be sure you've set up a mysql 
      username and given the username access to this database.
   4. Using your web browser, visit setup.php (in the directory you
      uploaded it to).
   5. If it is not done automatically in setup, you may need to rename
      config.php.txt to config.php and chmod it to 666.
   6. Follow the instructions on screen, supplying your database info
      and creating an administrative username and password -- be sure to
      remember your password as you'll need it to administrate your links.
   7. If it is not done automatically in setup (it will tell you), you
      may want to chmod your templates to 666 so that you can edit them
      through the online editor. Other items you may wish to chmod:
      searchlog.txt to 666, /attachments/ and /admin/ and /languages/ to
      777. Note: directory chmoding is server-specific, some servers may
      need 755 instead of 777. Warning: never chmod a directory to 666.
   8. If you are in safe mode, upload the languages you want from your
      languages/setup directory to /languages. Use englishonly.lng if
      you're doing an english-only install. Rename these languages to
      whatever you like after moving. *If you are running php in safe
      mode and forget to upload a language to /languages/, you will not
      be able to use your admin panel.* If you are *not* in safe mode,
      then this issue is doubly nonapplicable as it would work with that
      directory blank and also will properly copy over the language
      files you select during setup.
   9. Visit index.php to browse your links directory as a visitor, or
      /admin/ to administrate it. You may wish to update your settings
      to customize them to your site.



READ PRIOR TO UPGRADING FROM PREVIOUS VERSION

NOTE REGARDING CUSTOMIZATIONS: If you have made significant
customizations, it's strongly recommended that you consider using the
safe upgrade procedure described by Quantum:
http://scripts.webmastersite.net/wsnlinks/wsnmanual/comments.php?id=60

NOTE REGARDING ALL UPGRADES: config.php is the one file you need to keep
and not overwrite, as it contains the information for how to access your
database. The file in the download is named config.php.txt specifically
to prevent you from accidentally overwriting your config.php during an
upgrade. If by chance you've renamed it to config.php to do some testing
on localhost, be careful not to upload this file over your existing one.
If you do overwrite your config.php, however, see the manual for
information on how to re-create it.

NOTE REGARDING QUICK UPGRADE: You can do a simple and quick upgrade by
overwriting all files except attachments (including templates (be sure
to use /templates/default to overwrite your /templates directory if
you have templates there as a legacy from 1.x and early 2.x versions))
and then running the appropriate upgrade scripts in ascending order. 
(To upgrade from 2.10, for example, run upgrade2.1-2.2.php and then
upgrade2.2-2.3.php and then upgrade.php. To upgrade from 2.40, just run
upgrade.php.) However, if you've customized your templates a lot and wish
to only lose the minimum number of templates which you have to lose, 
follow the procedure below to see which templates to overwrite. Also, as
a rule, always go ahead and overwrite any template which you have not
customized. There are often minor improvements in them for which overwriting
is not expressly commanded.

NOTE REGARDING UPGRADING TEMPLATES: To upgrade your templates, you can
use a free program to highlight changed lines for you. See the manual
<http://scripts.webmastersite.net/wsnlinks/wsnmanual> for details.

NOTE REGARDING ERRORS DURING UPGRADE: If you get errors in upgrade.php,
this is likely just that it can't chmod or write to your templates, so
don't worry. If you're using member system integration, you may see some
error messages during upgrade. As long as the upgrade runs to
completion, this should not usually be cause for concern -- just pay
careful attention to the messages below the errors and follow any
instructions given.

IMPORTANT NOTE REGARDING "NO PERMISSION" MESSAGE DURING UPGRADE: If you
are unable to login to your WSN Links administrative account, you will
get a "no permission" message from the upgrade script. You must open
upgrade.php in a text editor and change "$emergencyupgrade = false;" to
"$emergencyupgrade = true;", then save the file and upload it. This will
allow you to run the upgrade without being logged in. Delete your
modified upgrade.php when done.

The sections below explain in detail the steps required to upgrade all
previous versions of WSN Links to the current version.

If you are upgrading from WSN Links Basic Edition, scroll past the other
upgrades to find instructions.

All template overwrites suggested here are of course optional, you may 
attempt to adapt your old templates if you wish -- however, that will 
be at your own risk if you decide not to overwrite.

TO UPGRADE FROM 3.12, 3.13 or 3.14:

   1. Upload to overwrite all files EXCEPT your /templates/ and /integration/ directories.
   2. Overwrite the /admin/ subdirectory of your templates directory.
   3. Upload the new badrequest.tpl template if upgrading from 3.12 or 3.13.
   4. Login to your WSN Links site as an administrator and run upgrade.php,
      by going to http://www.yoursite.com/wsnlinks/upgrade.php in your web browser.

TO UPGRADE FROM 3.11:

   1. Upload to overwrite all files EXCEPT your /templates/ and /integration/ directories.
   2. If your language files are not chmoded to 666, chmod them now.
   3. Overwrite the /admin/ subdirectory of your templates directory.
   4. Upload the templates banned.tpl, badrequest.tpl and tos.tpl
   5. Overwrite or adapt register.tpl and editmembers.tpl
   6. Login to your WSN Links site as an administrator and run upgrade.php,
      by going to http://www.yoursite.com/wsnlinks/upgrade.php in your web browser.

TO UPGRADE FROM 3.10:

   1. Upload to overwrite all files EXCEPT your /templates/ and /integration/ directories.
   2. If your language files are not chmoded to 666, chmod them now.
   3. Overwrite the /admin/ subdirectory of your templates directory.
   4. Upload the templates offline.tpl, badrequest.tpl, banned.tpl and tos.tpl. Overwrite register.tpl
       and editmembers.tpl. Adapt displaylinks.tpl to change
      <IF {SWITCH_ALBUMS}> to <IF {SWITCH_ALBUMS} and {THISMEMBERISREGISTERED}>
      or just overwrite.
   5. Multilingual versions only: overwrite your templates/multilingual/email.tpl template.
   6. Login to your WSN Links site as an administrator and run upgrade.php,
      by going to http://www.yoursite.com/wsnlinks/upgrade.php in your web browser.

TO UPGRADE FROM 3.0X:

   1. Upload to overwrite all files except your /integration/ directory, including
      templates. You may keep your wrapper template, but the switches won't all
      work unless you adapt/overwrite it.  
   2. If your language files are not chmoded to 666, chmod them now.
   3. Login to your WSN Links site as an administrator and run upgrade.php,
      by going to http://www.yoursite.com/wsnlinks/upgrade.php in your web browser.
   4. Redo all sponorships in your admin panel. Update usergroup permissions.
   5. If you have been using in-category searches, regenerate all links as the 
      upgrade will prompt you to.
 

TO UPGRADE FROM 2.5X:

   1. Download your config.php file, remove "$emailtable = 'WSN Links_email';"
      from it if it exists and upload the changed file.
   2. Upload to overwrite all files. (You may attempt to adapt templates if you wish.)
   3. If your language files are not chmoded to 666, chmod them now.
   4. Login to your WSN Links site as an administrator and run upgrade.php,
      by going to http://www.yoursite.com/wsnlinks/upgrade.php in your web browser.
   5. Go to the settings area of your admin panel and update usergroup
      permissions. Also update your 'manage redirects' page. Also re-set
      any category permissions you had. Redo sponsorships if you had any.


TO UPGRADE FROM ANY 2.3X or 2.4X VERSION:

   1. Go to your admin panel's 'manage languages' section and download a
      copy of each of your languages.
   2. Save your language(s) in your /languages/ directory of WSN Links
      on your computer. Name the files using the same file name as the
      title you have been using for the language. For example,
      english-only users should download their language and save it as
      default.lng while multilingual users should save as English.lng or
      Deutsch (Du).lng or Nederlands.lng, etc.
   3. Upload to overwrite all files (including templates).
   4. If your language files are not chmoded to 666, chmod them now.
   5. Login to your WSN Links site as an administrator and run upgrade.php,
      by going to http://www.yoursite.com/wsnlinks/upgrade.php in your web browser.
   6. Go to the settings area of your admin panel and update usergroup
      permissions. Also update your 'manage redirects' page.



For all older versions you will need to download the 'old upgrades'
package from http://scripts.webmastersite.net/wsnlinks/members/ and
upload those files to your main WSN Links directory before continuing.



TO UPGRADE FROM 2.2x:

   1. Go to your admin panel's 'manage languages' section and download a
      copy of each of your languages.
   2. Save your language(s) in your /languages/ directory of WSN Links
      on your computer. Name the files using the same file name as the
      title you have been using for the language. For example,
      english-only users should download their language and save it as
      default.lng while multilingual users should save as English.lng or
      Deutsch (Du).lng or Nederlands.lng, etc.
   3. Overwrite all files.
   4. If your language files are not chmoded to 666, chmod them now.
   5. Login to your WSN Links site as Administrator and run upgrade
      2.2-2.3.php
   6. As administrator run upgrade.php
   7. Go to the settings area of your admin panel and update usergroup
      permissions. Also update your 'manage redirects' page. Also re-set
      any category permissions you had. Redo sponsorships if you had any.


TO UPGRADE FROM 2.1x:

   1. Go to your admin panel's 'manage languages' section and download a
      copy of each of your languages.
   2. Save your language(s) in your /languages/ directory of WSN Links
      on your computer. Name the files using the same file name as the
      title you have been using for the language. For example,
      english-only users should download their language and save it as
      default.lng while multilingual users should save as English.lng or
      Deutsch (Du).lng or Nederlands.lng, etc.
   3. Overwrite all files.
   4. If your language files are not chmoded to 666, chmod them now.
   5. Run upgrade 2.1-2.2.php
   6. Run upgrade 2.2-2.3.php
   7. Run upgrade.php
   8. Go to the settings area of your admin panel and update usergroup
      permissions. Also update your 'manage redirects' page. Also re-set
      any category permissions you had. Redo sponsorships if you had any.

TO UPGRADE FROM 2.0x:

   1. Go to your admin panel's 'manage languages' section and download a
      copy of each of your languages.
   2. Save your language(s) in your /languages/ directory of WSN Links
      on your computer. Name the files using the same file name as the
      title you have been using for the language. For example,
      english-only users should download their language and save it as
      default.lng while multilingual users should save as English.lng or
      Deutsch (Du).lng or Nederlands.lng, etc.
   3. Overwrite all files.
   4. If your language files are not chmoded to 666, chmod them now.
   5. Run upgrade 2.0-2.1.php
   6. Run upgrade 2.1-2.2.php
   7. Run upgrade 2.2-2.3.php
   8. Run upgrade.php
   9. Go to the settings area of your admin panel and update usergroup
      permissions and also update your 'manage directs' page.

Note: Upgrading from 2.00 on up will not damage any custom fields you
may have.


TO UPGRADE FROM VERSIONS 1.x DIRECTLY TO THE CURRENT VERSION:

   1. In phpmyadmin, change the 'recip' field of wsnlinks_links to 'type'
      and run these queries: 
      UPDATE wsnlinks_links SET type='regular' where type='0';
      UPDATE wsnlinks_links SET type='recip' where type='1';
   2. Use phpmyadmin's export tab to download all data (not structure) of 
      your wsnlinks_links and wsnlinks_categories tables. Check the 'complete
      inserts' option box.
   3. Do a new install of WSN Links.
   4. In phpmyadmin, upload the data you exported before.
   5. In your admin panel, go to 'regenerate counters' and regenerate all types.


TO UPGRADE FROM WSN LINKS BASIC EDITION:

   1. Overwrite all files exept the /integration/ and /templates/
      directories.
   2. Overwrite the /admin subdirectory of your templates directory.
   3. Follow the instructions for upgrading from the version number of
      your basic edition. To upgrade from 2.56B, for example, go up to
      the instructions for upgrading from 2.56. If upgrading from 3.12B,
      go to the instructions for upgrading from 3.12.



IMPORTANT NOTE TO VERY LARGE DIRECTORIES

If you have many hundreds of categories, you may notice an increasing 
lag on the 'suggest category' and 'edit category' pages after submitting.
 To avoid this (and avoid possible script timeouts) you will need to 
follow the instructions at 
http://scripts.webmastersite.net/wsnlinks/wsnmanual/articles/172 

Also see http://scripts.webmastersite.net/wsnlinks/wsnmanual/articles/189



OTHER DOCUMENTATION

See the manual at http://scripts.webmastersite.net/wsnlinks/wsnmanual/ .
Be sure to check there, as it may answer your question.

Failing that, ask around on the forum:
http://www.webmastersite.net/forums/WSN_Links ... be sure to do
a search of previous posts as well. You may also fill out the email
support form at http://scripts.webmastersite.net/wsnlinks/members/?custom=yes&TID=custom-support , but please
search the manual and forum first.

If you encounter a bug, please report it at
http://www.webmastersite.net/forums/WSN_Links to get a quick
fix for yourself and also help improve the next WSN Links release. Be
sure to read the pinned bug report procedure thread since without the
information requested there it is impossible to know anything about the
nature of the error. (The regular php/mysql warnings are not useful,
since they always point to database.php regardless of where the real
problem is.)



THANKS!

Thanks for purchasing WSN Links. Your purchase supports the past, present and future development of the script.
